-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Javadocs] add remaining internal classes and reenable missingJavadoc on server #3296
[Javadocs] add remaining internal classes and reenable missingJavadoc on server #3296
Conversation
645ced6
to
ce83ed4
Compare
❌ Gradle Check failure ce83ed489f4c91184e8822a0c4c726319e71ca7c |
… on server Adds the remaining javadocs to internal classes and reenables the missingJavadoc gradle task on the server module. Signed-off-by: Nicholas Walter Knize <[email protected]>
Signed-off-by: Nicholas Walter Knize <[email protected]>
ce83ed4
to
3d97ca1
Compare
Signed-off-by: Nicholas Walter Knize <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great!
Just curious, do we have any tooling (or plans for tooling) that enforce that @opensearch.internal
annotated classes aren't used externally?
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-3296-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 3aef125d0dbf2f29d9bf00b84cb52892a27a5328
# Push it to GitHub
git push --set-upstream origin backport/backport-3296-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x Then, create a pull request where the |
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.0 2.0
# Navigate to the new working tree
cd .worktrees/backport-2.0
# Create a new branch
git switch --create backport/backport-3296-to-2.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 3aef125d0dbf2f29d9bf00b84cb52892a27a5328
# Push it to GitHub
git push --set-upstream origin backport/backport-3296-to-2.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.0 Then, create a pull request where the |
No... (not yet). For now the only enforcement would be to follow up and refactor any sloppily used modifiers from |
Hi, So one could generate signatures files automatically after compile. The question is more: why would anybody use it in downstream code? |
I'm thinking of it being used in an opensearch plugin specific context. Something like K-NN plugin which now injects a custom codec - whereas before it was overriding the entire engine. There are certain classes we just don't want to be able to override in a downstream plugin. We're getting better about fixing the class modifiers (Elastic never worried about this since it was never a community project) but we have a long way to go. In the meantime I've started liberally applying the I wonder if we could enforce this in |
… on server (#3296) Adds the remaining javadocs to internal classes and reenables the missingJavadoc gradle task on the server module. From here forward if class level javadocs are missing in the server module, gradle check will fail! Signed-off-by: Nicholas Walter Knize <[email protected]> (cherry picked from commit 3aef125)
… missingJavadoc on server (#3296) (#3318) Adds the remaining javadocs to internal classes and reenables the missingJavadoc gradle task on the server module. From here forward if class level javadocs are missing in the server module, gradle check will fail! Signed-off-by: Nicholas Walter Knize <[email protected]> (cherry picked from commit 3aef125)
… on server (opensearch-project#3296) Adds the remaining javadocs to internal classes and reenables the missingJavadoc gradle task on the server module. From here forward if class level javadocs are missing in the server module, gradle check will fail! Signed-off-by: Nicholas Walter Knize <[email protected]>
… missingJavadoc on server (#3296) (#3319) Adds the remaining javadocs to internal classes and reenables the missingJavadoc gradle task on the server module. From here forward if class level javadocs are missing in the server module, gradle check will fail! Signed-off-by: Nicholas Walter Knize <[email protected]>
Adds the remaining javadocs to internal classes and reenables the missingJavadoc
gradle task on the server module. From here forward if class level javadocs are
missing in the server module, gradle check will fail!
relates #221
relates #2868